Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Giving Nodes a Type #4040

Merged
merged 2 commits into from
Oct 19, 2019
Merged

Remove Giving Nodes a Type #4040

merged 2 commits into from
Oct 19, 2019

Conversation

MichelDiz
Copy link
Contributor

@MichelDiz MichelDiz commented Sep 22, 2019

This is deprecated in favor of the new Type System.


This change is Reviewable

This is deprecated in favor of the new Type System.
Copy link

@pullrequest pullrequest bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ A review job has been created and sent to the PullRequest network.


@MichelDiz you can click here to see the review status or cancel the code review job.

Copy link

@pullrequest pullrequest bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Always good to remove deprecated documentation :)


Reviewed with ❤️ by PullRequest

Copy link
Contributor

@MichaelJCompton MichaelJCompton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @danielmai, @MichaelJCompton, and @MichelDiz)


wiki/content/howto/index.md, line 377 at r1 (raw file):

Quoted 12 lines of code…
It's often useful to give the nodes in a graph *types* (also commonly referred
to as *labels* or *kinds*).

This allows you to do lots of useful things. For example:

- Search for all nodes of a certain type in the root function.

- Filter nodes to only be of a certain kind.

- Enable easier exploration and understanding of a dataset. Graphs are easier
  to grok when there's an explicit type for each node, since there's a clearer
expectation about what predicates it may or may not have.

Really like the idea of removing the section. My only question is if this kind of description now belongs at the top of the types section in the docs? Or do you think that by just calling it types removes the need for any of this?

Copy link
Contributor Author

@MichelDiz MichelDiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @danielmai and @MichaelJCompton)


wiki/content/howto/index.md, line 377 at r1 (raw file):

Previously, MichaelJCompton (Michael Compton) wrote…
It's often useful to give the nodes in a graph *types* (also commonly referred
to as *labels* or *kinds*).

This allows you to do lots of useful things. For example:

- Search for all nodes of a certain type in the root function.

- Filter nodes to only be of a certain kind.

- Enable easier exploration and understanding of a dataset. Graphs are easier
  to grok when there's an explicit type for each node, since there's a clearer
expectation about what predicates it may or may not have.

Really like the idea of removing the section. My only question is if this kind of description now belongs at the top of the types section in the docs? Or do you think that by just calling it types removes the need for any of this?

This session came with time becoming unnecessary, I believe it was because of it that we started the idea of having a Type System. I have already highly recommended this approach from that session myself. But the use of "has ()" is somewhat counter-prudent at root. (Although we are always improving has()func over time).

As for the description, I cannot say how we could convey its meaning there. But it is a fact that this approach is inefficient than using the Type System. (but will not be removed, only discouraged and removed from docs*).

Copy link

@pullrequest pullrequest bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Due to inactivity, PullRequest has cancelled this review job. You can reactivate the code review job from the PullRequest dashboard

Copy link
Contributor

@martinmr martinmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 1 of 1 files at r1.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @danielmai and @MichaelJCompton)

Copy link
Contributor

@danielmai danielmai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:. FYI, removing this section will break any existing URLs that refer to this page. We can either remove it, or keep it and link to https://docs.dgraph.io/query-language/#type-system.

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @danielmai and @MichaelJCompton)

Copy link
Contributor Author

@MichelDiz MichelDiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure, I think I could seek for pointing URLs and eliminate them. What I'm not sure is about left deprecated info in the docs and just left a "note" about it. If this is a good move in terms of maintaining good documentation.

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @MichaelJCompton)

Copy link
Contributor

@danielmai danielmai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @martinmr and @MichaelJCompton)

@MichelDiz MichelDiz merged commit 8a5c2f2 into master Oct 19, 2019
@MichelDiz MichelDiz deleted the michel/remove_deprecated-docs branch October 19, 2019 01:41
danielmai pushed a commit that referenced this pull request Nov 16, 2019
* Remove Giving Nodes a Type

This is deprecated in favor of the new Type System.

* add Dmai's suggestion of leaving a reference there.

(cherry picked from commit 8a5c2f2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants